home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / aminet / dev / c / cformat.lha / CFormat / CFormat.DOK < prev    next >
Text File  |  1992-06-07  |  4KB  |  134 lines
  1.                                     CFormat
  2.                                     =======
  3.  
  4.                         C-Source-Formatierungsprogramm
  5.                         ==============================
  6.  
  7.                           (c) 1992 by Rüdiger Dreier
  8.  
  9.                                  Version 3.10
  10.                                  ------------
  11.  
  12. 0. Rechtliches
  13. ==============
  14. Dieses Programm ist FREEWARE. Es darf weitergegeben werden, solange damit kein
  15. Geld verdient wird. Weitergegeben werden muß immer das gesamte Paket, also
  16.  - Dokumentation
  17.  - lauffähiges Programm
  18.  
  19. DER AUTHOR ÜBERNIMMT KEINE HAFTUNG FÜR SCHÄDEN (DATENVERLUSTE, ZEITVERLUSTE,
  20. FINANZIELLE EINBUßEN ETC.), DIE AUS DER BENUTZUNG DIESES PROGRAMMS ENTSTEHEN.
  21.  
  22. Falls jemand Verbesserungsvorschläge, Fehlermeldungen, Kritik, Geld etc. für
  23. mich hat, meine Adresse:
  24.  
  25.                             Rüdiger Dreier
  26.                             Gustav-Winkler Str. 40
  27.                      W-4800 Bielefeld 18
  28.                             Germany
  29.  
  30. Bei Anfragen bitte genügend Rückporto beilegen !
  31.  
  32. Bis Ende Oktober 92 kann ich auch erreicht werden unter
  33.  
  34.  uphya600@unibi.hrz.uni-bielefeld.de
  35.  
  36. Allerdings sehe ich nicht sehr häufig in meinem "Briefkasten" nach.
  37.  
  38.  
  39. 1. Einleitung:
  40. ==============
  41. CFormat ist ein Programm, das  den Quelltext eines C-Programmes formatiert.
  42. Dadurch werden Blöcke und #define's übersichtlicher.
  43. Beispiel:
  44. Aus
  45.  
  46. main(){#ifdef DEBUG
  47. printf("Start\n");#endif
  48. Testfun(1,2,3,4);
  49. #ifdef DEBUG
  50. printf("End\n");
  51. #endif
  52. }
  53.  
  54. Testfun(LONG i,
  55. int a,
  56. SHORT b,
  57. char c){printf("%ld %d %d %c\n",i,a,b,c);}
  58.  
  59. wird
  60.  
  61.  main()
  62.   {
  63. #ifdef DEBUG
  64.    printf("Start\n");
  65. #endif
  66.    Testfun(1,2,3,4);
  67. #ifdef DEBUG
  68.    printf("End\n");
  69. #endif
  70.   }
  71.  
  72.  Testfun(LONG i,
  73.          int a,
  74.          SHORT b,
  75.          char c)
  76.   {
  77.    printf("%ld %d %d %c\n",i,a,b,c);
  78.   }
  79.  
  80. Besser, oder ?
  81. (Das ist meine Art, einen C-Quelltext zu formatieren. Wer eine andere
  82.  Art bevorzugt ist mit diesem Programm schlecht bedient.)
  83.  
  84. Das Programm erkennt eine ganze Reihe von Fällen, in denen Sonderzeichen,
  85. die normalerweise eine neue Zeile/Einrückung hervorrufen, in Strings
  86. stehen, es ist aber nicht ganz sicher, daß es wirklich ALLE Fälle erkennt.
  87. Dies erkennt man, wenn das Programm Fehler meldet, wo keine sind und in
  88. der erzeugten Datei Strings auseinander gerissen sind.
  89.  
  90.  
  91.  
  92. 2 Anwendung
  93. ===========
  94. CFormat wird vom CLI oder der Workbench aus benutzt.
  95.  
  96. Start vom CLI:
  97. Es gibt zwei Möglichkeiten:
  98.  1. CFormat VON NACH <RETURN>
  99.  2. CFormat          <RETURN>
  100. Bei der zweiten Möglichkeit fragt CFormat die beiden nötigen Filenamen ab.
  101. Falls eins der Files nicht geöffnet werden kann, so wird eine Fehlermeldung
  102. ausgegeben und das Programm beendet.
  103. CFormat meldet sich dann mit
  104.  Formatiere von VON nach NACH
  105. Nach erfolgreicher Arbeit meldet sich CFormat mit >Fertig - Kein Fehler<. Falls
  106. ein Fehler aufgetreten ist, wird angegeben, was zu viel oder zu wenig war, also
  107. Unpaarige ', " /*...*/, (..), {..}. In NACH steht die Datei dann so, wie sie
  108. ohne die notwendigen paarigen Zeichen formatiert wird. Aus dieser Datei kann
  109. man dann meistens ersehen, wo ein Zeichen fehlt/zu viel ist.
  110.  
  111. Start von der Workbench:
  112. Auch hier gibt es zwei Möglichkeiten:
  113. Die normale erweiterte Auswahl (alle gewünschten Files mit der Maus
  114. anklicken, SHIFT dabei gedrückt halten und als letztes ein Doppelklick
  115. auf das Programmicon)
  116. Die zweite Möglichkeit unterscheidet sich von der ersten nur dadurch,
  117. daß das Programm nicht dort sein muß, wo das Programmicon ist. Dazu
  118. wird das Programm nach C: oder LC: kopiert und im Icon unter Default Tool
  119. der Name des Programms mit vollen Pfad angegeben. Beim Starten ist jetzt
  120. nur zu beachten, daß zunächst das Programmicon und danach die gewünschten
  121. Texticons angewählt werden müssen. Der Doppelklick muß beim letzten
  122. Texticon geschehen.
  123. Besitzer des SAS-C Compilers kopieren das Icon (ohne das Programm) am Besten
  124. in den Ordner Starter-Project, dann wird beim Aufruf von SASCSETUP das
  125. Icon automatisch mitkopiert.
  126.  
  127. Bei der Benutzung des Programm von der Workbench aus wird die formatierte
  128. Datei wieder unter dem alten Namen abgespeichert, aber nur, wenn kein
  129. Fehler aufgetreten ist. Die notwendige Hilfsdatei wird in T: angelegt.
  130.  
  131.  
  132.  
  133.                                   Viel Spaß !
  134.